home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1995 #2 / Amiga Plus CD - 1995 - No. 2.iso / internet / faq / englisch / suggested_minimal_digest < prev    next >
Encoding:
Text File  |  1995-04-11  |  9.7 KB  |  252 lines
  1. Archive-name: faqs/minimal-digest-format
  2. Posting-frequency: every 20 days
  3. Last-modified: Wed Jan 25 23:54:34 EST 1995
  4.  
  5.         FAQs: A Suggested Minimal Digest Format
  6.                Chris Lewis
  7.         clewis@ferret.ocunix.on.ca
  8.  
  9.  
  10.     The latest edition of this FAQ can always be retrieved from:
  11.  
  12.     ftp://rtfm.mit.edu/pub/usenet/news.answers/faqs/minimal-digest-format
  13.  
  14. Changes: URLs are now documented in RFC1630.
  15.    
  16. ------------------------------
  17.  
  18. Subject: 1. Introduction and Intent
  19.  
  20. The intent of this FAQ is to provide current and future FAQ maintainers
  21. with a simple description of a minimal format for FAQs.  This minimal
  22. format is a simplification of RFC1153 digest format that is sufficient
  23. to be compatible with common newsreader digest handling functionality,
  24. current practise, and Thomas Fine's "FAQ digest format to HTML"
  25. converter which allows more sophisticated viewing on HTML-aware systems
  26. such as Mosaic or WWW.  There are other more sophisticated formats that
  27. you can use, but this is the simplest one that is compatible with a wide
  28. range of software that understands digest format.
  29.  
  30. This format is entirely optional.  But it is designed to give you the
  31. biggest "bang per buck" in terms of existing software compatibility and
  32. minimum effort.  If you believe that your FAQ can benefit from more
  33. sophisticated formats, by all means use them.  As such, this FAQ can be
  34. simply considered a guide on how to take advantage of some basic digest
  35. capabilities in end-user viewing software.
  36.  
  37. Rather than confuse the issue by documenting all of the variation
  38. allowed by existing practise and software, this documents a single
  39. variant.  However, it can be extended by reviewing the documentation
  40. for Thomas Fine's FAQ to HTML converter:
  41.  
  42. <http://www.cis.ohio-state.edu/hypertext/faq/usenet/faq-format/top.html>
  43.  
  44. This FAQ is written entirely in the minimal digest format, and can be
  45. used as an example.  You can skip from one section to the next
  46. by pressing ^G in many newsreaders, such as rn, trn and strn.
  47.  
  48. This FAQ describes only how FAQ sections should be delimited, and
  49. a couple of suggestions for meta-references to such things as FTP
  50. or WWW repositories in formats that other tools support.
  51.  
  52. Note to reader software implementors: you should not take this format
  53. as gospel, instead, use it as a guide to one minimal format of many
  54. more sophisticated ones.  You should really be reading RFC1153,
  55. Thomas Fine's material, and consulting news.answers for how FAQS
  56. are formatted in real life.  See "Newsreader/Converter Specifics"
  57. for descriptions of how some newsreaders work with digest-like documents.
  58.  
  59. ------------------------------
  60.  
  61. Subject: 2. Table of Contents
  62.  
  63.     1. Introduction and Intent
  64.     2. Table of Contents
  65.     3. What Should the Overall FAQ Look Like?
  66.     4. What's a Section, and How is it Formatted?
  67.     5. What is the Table of Contents Format?
  68.     6. What are External Meta References,
  69.         and What is Their Format?
  70.     7. Where Do I need to Look for Other Information?
  71.     8. Newsreader/Converter Specifics
  72.  
  73. ------------------------------
  74.  
  75. Subject: 3. What Should the Overall FAQ Look Like?
  76.  
  77. Most FAQs lend themselves to a format like:
  78.  
  79.     <news headers>
  80.     <news.answers required headers if the FAQ is registered>
  81.     <title and author>
  82.     <section>
  83.     <section>
  84.     <section>
  85.     <section>
  86.  
  87. While FAQs aren't always lists of questions and answers, they usually
  88. have "sections" of text -- whether they be sets of lists, individual
  89. Q&A's, groups of Q&A, textual sections, whatever.  The digest format
  90. is all about how these sections should be delimited for automatic parsing.
  91.  
  92. |Note that this FAQ doesn't attempt to explain the news headers and
  93. |news.answers subheaders.  For this, you should really consult the
  94. |FAQs on how to create news.answers postings.  It's worth noting a
  95. |few things here.  You should use Expires/Supercedes to manage the
  96. |deletion of previous copies of your FAQ.  It is also a very good idea
  97. |to use References: lines to link the parts of multi-part FAQs together
  98. |so that they remain together with Usenet news readers.
  99.  
  100. ------------------------------
  101.  
  102. Subject: 4. What's a Section, and How is it Formatted?
  103.  
  104. A "section" is merely a block of text.  In many FAQs they are simply
  105. the introduction paragraph, the table of contents, and each question
  106. and answer.  Through the use of digest format, most newsreaders can
  107. skip from section to section using the convention presented here, and
  108. more sophisticated packages can hypertext them.
  109.  
  110. A "section" consists of:
  111.  
  112.     <blank line>
  113.     <string of 30 hyphens>
  114.     <blank line>
  115.     Subject: <subject line>
  116.     <additional optional RFC822-like headers>
  117.     <blank line>
  118.     <text>
  119.  
  120. Note that the string of hyphens and "Subject:" must start in column one.
  121. "Subject:" has one space or tab between it and the subject line.  If you have
  122. to put "Subject:" in and don't want it interpreted as a section header, just
  123. make sure that it isn't in column one (just like above).  If your subject
  124. line is too wide to fit in 80 columns, you can continue it onto the next
  125. lines, with whitespace at the beginning of the following lines.  Example:
  126.  
  127.     Subject: this is a long........
  128.         subject line
  129.  
  130. The subject can be any arbitrary string of text.  You may wish to use
  131. a numbering scheme, for it makes it easier for your readers to "grep"
  132. down to the precise section they want.
  133.  
  134. You can place additional RFC-like headers after the Subject, such as
  135. "From:", "Date:" etc.  Again, these headers should start in column
  136. one.  There should be no blank lines in the entire set of headers
  137. in a section.
  138.  
  139. The text is free format ASCII and may be formatted any way you wish.
  140.  
  141. Current FAQ maintainers take note: if you're already using a consistent
  142. format for your FAQ, converting to this format will often require only
  143. one or two global edit commands.
  144.  
  145. ------------------------------
  146.  
  147. Subject: 5. What is the Table of Contents Format?
  148.  
  149. The Table of Contents simply consists of the subject lines from the rest
  150. of the FAQ, excluding "Subject:", and preferably indented.  The subject lines
  151. should be exact copies of the section headers.
  152.  
  153. This is only a suggestion.  There is no existing software that parses this
  154. data.  The intent of using exactly the same strings as the subjects is
  155. so that users can use search mechanisms to find specific sections.  If the
  156. subject line is too long to fit in a table of contents line, it is suggested
  157. that you truncate it at a convenient point - the search will still work.
  158.  
  159. ------------------------------
  160.  
  161. Subject: 6. What are External Meta References,
  162.     and What is Their Format?
  163.  
  164. Many of the more sophisticated viewers can "jump" from one FAQ to the
  165. next, retrieve data via FTP, or send email simply by "pointing at"
  166. properly formatted "tags" in your FAQ.  This FAQ recommends "URL"
  167. ("Universal Resource Locator") format tags.  See Section 7 for a
  168. reference.
  169.  
  170. If your FAQ refers to a FTP-able file, use this format:
  171.  
  172.     ftp://<inet>/<str>/<str>
  173.  
  174. Where "<inet>" is the Internet domain name of the server, and the rest
  175. of the "<str>/<str>" is the file name.  If you want to refer to a directory,
  176. leave a trailing "/".
  177.  
  178. This string can be anywhere in the document, inline with text or whatever.
  179.  
  180. Similarly, for html (hypertext markup language)-compatible documents,
  181. use http://<inet>/<str>/<str>
  182.  
  183. For clarity, it's best to surround the URL with angle brackets to make
  184. it easier to parse.  This FAQ uses this convention, ie:
  185.  
  186.    <ftp://ftp.uunet.ca/distrib/chris_lewis/hp2pbm/>
  187.  
  188. One difficulty with URLs is that they're often quite long.  Do not
  189. break them in the middle, or they won't work.  It is suggested that
  190. if the URL is too long to fit, start a new line with the URL.  Even
  191. if it does look rather ugly, it's better than not working, or wrapping
  192. beyond the 80th column.
  193.  
  194. ------------------------------
  195.  
  196. Subject: 7. Where Do I need to Look for Other Information?
  197.  
  198. [These seemed relevant, but I need descriptions!]
  199. <http://www.cis.ohio-state.edu/hypertext/usenet/faq-format/www/faq.html>,
  200. <http://www.cis.ohio-state.edu/hypertext/faq/usenet/faq-format/top.html>
  201. <http://www.cis.ohio-state.edu/hypertext/faq/usenet/technical-notes/faq.html>
  202.  
  203. John E. Goodwin's <JEGOODWIN@delphi.com> "Elements of E-Text Style",
  204.  
  205. |Note the specification of URLs is now to be found in rfc1630:
  206. |
  207. |"Universal Resource Identifiers in WWW"  [Jun 94]
  208. | by Tim Berners-Lee <timbl@info.cern.ch>
  209. | URL <ftp://ds.internic.net/rfc/rfc1630.txt>
  210. |     <ftp://ftp.isi.edu/in-notes/rfc1630.txt>
  211. |     <http://info.cern.ch/hypertext/WWW/Addressing/URL/URL_Overview.html>
  212. ------------------------------
  213.  
  214. Subject: 8. Newsreader/Converter Specifics
  215.  
  216. Rn, trn, and strn "^G" functionality skips to the next occurance of
  217. "Subject:" in column one.
  218.  
  219. GNUs has two "digest" parsers.  One insists on full RFC1153 compliance
  220. (main Subject: line "digest" tokens etc.), and the other skips to lines
  221. with (at least 8?) hyphens starting in column 1.
  222.  
  223. Tin has no digest functionality at present, though, tin's author indicates
  224. willingness to add it in a way compatible with this format.  This author
  225. suggests either the "^Subject:" or "^-*" approach.
  226.  
  227. Nn triggers on Subject: plus From: which is often not applicable
  228. to FAQs.  Nn "explodes" FAQs with both Subject: and From: subheaders
  229. into individual articles.  Most nn users this author has discussed this
  230. with do not want FAQs to behave this way, which is why this format doesn't
  231. require "From:" lines.
  232.  
  233. Thomas Fine's FAQ to HTML conversion system uses a scoring system to
  234. measure compliance with the:
  235.  
  236.     <blank line>
  237.     <line of hyphens>
  238.     <blankline>
  239.     Subject: <subject>
  240.  
  241. format.  See the following for more detail:
  242.  
  243. <http://www.cis.ohio-state.edu/hypertext/faq/usenet/faq-format/top.html>
  244.  
  245. I would appreciate detail on digest/FAQ parsing in other newsreaders and
  246. conversion systems.
  247. -- 
  248. Chris Lewis: _Una confibula non sat est_
  249. Phone: Canada 613 832-0541
  250. Latest psroff: FTP://ftp.uunet.ca/distrib/chris_lewis/psroff3.0pl17/*
  251. Latest hp2pbm: FTP://ftp.uunet.ca/distrib/chris_lewis/hp2pbm/*
  252.